<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>EOS.IO: contracts/eoslib/transaction.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EOS.IO
   &#160;<span id="projectnumber">DAWN1.1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ae9b15dd87e066e1908bbd90e8f38627.html">contracts</a></li><li class="navelem"><a class="el" href="dir_3fea0bf1ce879ce73e6ecec98007efcd.html">eoslib</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">transaction.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="transaction_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="types_8h.html">eoslib/types.h</a>&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">   62</a></span>&#160;   <span class="keyword">typedef</span> <a class="code" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="code" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a>;</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="group__transactioncapi.html#ga58df052e13ad2a3d54a2b1c99a2a8925">   63</a></span>&#160;<span class="preprocessor">   #define InvalidTransactionHandle (0xFFFFFFFFUL)</span></div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;   </div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">   65</a></span>&#160;   <span class="keyword">typedef</span> <a class="code" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="code" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="group__transactioncapi.html#ga4b337c3f5a641ee82e84d209a8bba0d7">   66</a></span>&#160;<span class="preprocessor">   #define InvalidMessageHandle (0xFFFFFFFFUL)</span></div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;   TransactionHandle <a class="code" href="group__transactioncapi.html#ga180dc33e735f9631ed9a800d7b0a511e">transactionCreate</a>();</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__transactioncapi.html#ga347cc9c284bc25ed1d67b596e2320cdc">transactionRequireScope</a>(TransactionHandle trx, <a class="code" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> scope, <span class="keywordtype">int</span> readOnly = 0);</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__transactioncapi.html#ga1290a226d7828410020ed2954ffa5fa5">transactionAddMessage</a>(TransactionHandle trx, MessageHandle msg);</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__transactioncapi.html#ga01eab43648b29422885d4d59a2864aaf">transactionSend</a>(TransactionHandle trx);</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__transactioncapi.html#ga37162c1f843ae69d0134be29b1cde61f">transactionDrop</a>(TransactionHandle trx);</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;   </div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;   MessageHandle <a class="code" href="group__transactioncapi.html#ga6940a3e31486bef36409f857e0ed7c72">messageCreate</a>(<a class="code" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> code, <a class="code" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> type, <span class="keywordtype">void</span> <span class="keyword">const</span>* data, <span class="keywordtype">int</span> size);</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;</div><div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__transactioncapi.html#gabf3f53f695c30abe4bd48f9b3341a016">messageRequirePermission</a>(MessageHandle msg, <a class="code" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> account, <a class="code" href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a> permission);</div><div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__transactioncapi.html#ga1f9346e3ef3fae10cf5fee5b9a0270ca">messageSend</a>(MessageHandle msg);</div><div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;</div><div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;</div><div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__transactioncapi.html#ga77f1412808c199633b41bf2f20e3cb45">messageDrop</a>(MessageHandle msg);</div><div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;</div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;</div><div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;}</div><div class="ttc" id="types_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div></div>
<div class="ttc" id="group__types_html_gad67b43dc23285b01176f4c181c59fc23"><div class="ttname"><a href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a></div><div class="ttdeci">uint64_t AccountName</div><div class="ttdef"><b>Definition:</b> types.h:24</div></div>
<div class="ttc" id="group__types_html_ga4c11ea58b1daa61a364225a757a05cd2"><div class="ttname"><a href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a></div><div class="ttdeci">uint64_t FuncName</div><div class="ttdef"><b>Definition:</b> types.h:29</div></div>
<div class="ttc" id="group__transactioncapi_html_gaa42fca851fc0bcfd9dffc229c9552ce5"><div class="ttname"><a href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a></div><div class="ttdeci">uint32_t MessageHandle</div><div class="ttdef"><b>Definition:</b> transaction.h:65</div></div>
<div class="ttc" id="group__transactioncapi_html_ga37162c1f843ae69d0134be29b1cde61f"><div class="ttname"><a href="group__transactioncapi.html#ga37162c1f843ae69d0134be29b1cde61f">transactionDrop</a></div><div class="ttdeci">void transactionDrop(TransactionHandle trx)</div><div class="ttdoc">drop a pending transaction </div></div>
<div class="ttc" id="group__types_html_ga06896e8c53f721507066c079052171f8"><div class="ttname"><a href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a></div><div class="ttdeci">unsigned long uint32_t</div><div class="ttdef"><b>Definition:</b> types.h:18</div></div>
<div class="ttc" id="group__transactioncapi_html_ga1f9346e3ef3fae10cf5fee5b9a0270ca"><div class="ttname"><a href="group__transactioncapi.html#ga1f9346e3ef3fae10cf5fee5b9a0270ca">messageSend</a></div><div class="ttdeci">void messageSend(MessageHandle msg)</div><div class="ttdoc">send a pending message as an inline message </div></div>
<div class="ttc" id="group__transactioncapi_html_ga7a095ea0165891d5ee1dbd8ee40e32cb"><div class="ttname"><a href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a></div><div class="ttdeci">uint32_t TransactionHandle</div><div class="ttdef"><b>Definition:</b> transaction.h:62</div></div>
<div class="ttc" id="group__transactioncapi_html_ga77f1412808c199633b41bf2f20e3cb45"><div class="ttname"><a href="group__transactioncapi.html#ga77f1412808c199633b41bf2f20e3cb45">messageDrop</a></div><div class="ttdeci">void messageDrop(MessageHandle msg)</div><div class="ttdoc">discard a pending message </div></div>
<div class="ttc" id="group__transactioncapi_html_ga347cc9c284bc25ed1d67b596e2320cdc"><div class="ttname"><a href="group__transactioncapi.html#ga347cc9c284bc25ed1d67b596e2320cdc">transactionRequireScope</a></div><div class="ttdeci">void transactionRequireScope(TransactionHandle trx, AccountName scope, int readOnly=0)</div><div class="ttdoc">require a scope to process a pending transaction </div></div>
<div class="ttc" id="group__transactioncapi_html_gabf3f53f695c30abe4bd48f9b3341a016"><div class="ttname"><a href="group__transactioncapi.html#gabf3f53f695c30abe4bd48f9b3341a016">messageRequirePermission</a></div><div class="ttdeci">void messageRequirePermission(MessageHandle msg, AccountName account, PermissionName permission)</div><div class="ttdoc">require a permission for the pending message </div></div>
<div class="ttc" id="group__transactioncapi_html_ga01eab43648b29422885d4d59a2864aaf"><div class="ttname"><a href="group__transactioncapi.html#ga01eab43648b29422885d4d59a2864aaf">transactionSend</a></div><div class="ttdeci">void transactionSend(TransactionHandle trx)</div><div class="ttdoc">send a pending transaction </div></div>
<div class="ttc" id="group__transactioncapi_html_ga1290a226d7828410020ed2954ffa5fa5"><div class="ttname"><a href="group__transactioncapi.html#ga1290a226d7828410020ed2954ffa5fa5">transactionAddMessage</a></div><div class="ttdeci">void transactionAddMessage(TransactionHandle trx, MessageHandle msg)</div><div class="ttdoc">finalize the pending message and add it to the transaction </div></div>
<div class="ttc" id="group__types_html_ga4bd93be9c597a8d7b6a1a3504ca63e83"><div class="ttname"><a href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a></div><div class="ttdeci">uint64_t PermissionName</div><div class="ttdef"><b>Definition:</b> types.h:25</div></div>
<div class="ttc" id="group__transactioncapi_html_ga180dc33e735f9631ed9a800d7b0a511e"><div class="ttname"><a href="group__transactioncapi.html#ga180dc33e735f9631ed9a800d7b0a511e">transactionCreate</a></div><div class="ttdeci">TransactionHandle transactionCreate()</div><div class="ttdoc">create a pending transaction </div></div>
<div class="ttc" id="group__transactioncapi_html_ga6940a3e31486bef36409f857e0ed7c72"><div class="ttname"><a href="group__transactioncapi.html#ga6940a3e31486bef36409f857e0ed7c72">messageCreate</a></div><div class="ttdeci">MessageHandle messageCreate(AccountName code, FuncName type, void const *data, int size)</div><div class="ttdoc">create a pending message </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
